style: replace black, isort, flake8 and autoflake with ruff by schwarbf · Pull Request #456 · docling-project/docling-core

schwarbf · 2025-12-10T21:17:18Z

This PR aims to close the open issue 453.

I tried to do as little code changes as possible. I did the following:

I started taking the ruff config from the docling repository
Using ruff now as a replacement for black, isort, autoflake and flake8
Ran ruff format (formatted approx. 30 files) and ruff check --fix (fixed approx. 50 warnings)
Excluded the test/data from ruff
Added some rules to the ignore list that would have affected > 3 changes. Feel free to remove any again to see possible changes.
Set the line length again to 120 in pyproject.toml (was 120 in .flake8 file, but 88 in pyproject.toml)

FYI: When checking which commit added ruff to docling, you can see that 5458a88
also changed a significant number of files and added some rules to the ignore list.

github-actions · 2025-12-10T21:17:30Z

✅ DCO Check Passed

Thanks @schwarbf, all your commits are properly signed off. 🎉

dosubot · 2025-12-10T21:17:49Z

Related Documentation

Checked 7 published document(s) in 0 knowledge base(s). No updates required.

^{How did I do? Any feedback?}

mergify · 2025-12-10T21:17:52Z

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

🟢 Require two reviewer for test updates

Wonderful, this rule succeeded.

When test data is updated, we require two reviewers

#approved-reviews-by >= 2

ceberam · 2025-12-12T08:44:11Z

docling_core/transforms/chunker/code_chunking/code_chunk.py

+    part_name: str | None = Field(default=None)
+    docstring: str | None = Field(default=None)
+    sha256: int | None = Field(default=None)
+    start_line: int | None = Field(default=None)
+    end_line: int | None = Field(default=None)
+    end_line_signature: int | None = Field(default=None)


Was this suggested by Ruff?
We still support 3.9 (it may change at some point) and the | syntax is only valid from 3.10. We should therefore keep typing.Optional

Okay I see. It's weird since I had actually set :

[tool.ruff] target-version = "py39"

Anyways, I will revert this part.

Thanks! However, I've seen that the syntax is still in other places, like in test/test_page_chunker.py

Can you please check again? I found 2 remaining spots, where the syntax dtype | None was used instead of Optional[dtype]. The respective rule UP045 is also in the ignore list such that no errors are raised in the future.

schwarbf · 2025-12-12T20:49:53Z

@ceberam PR should be ready. Let me know if you want me to rebase or merge with docling-core:main or if you want to do it yourself?

codecov · 2026-01-12T14:54:54Z

Codecov Report

❌ Patch coverage is 78.85305% with 118 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
docling_core/types/doc/page.py	48.71%	20 Missing ⚠️
docling_core/experimental/idoctags.py	79.12%	19 Missing ⚠️
docling_core/transforms/serializer/html.py	61.53%	10 Missing ⚠️
...s/chunker/code_chunking/_language_code_chunkers.py	92.17%	9 Missing ⚠️
docling_core/types/legacy_doc/doc_ocr.py	0.00%	9 Missing ⚠️
docling_core/types/legacy_doc/base.py	70.00%	6 Missing ⚠️
...ocling_core/search/json_schema_to_search_mapper.py	63.63%	4 Missing ⚠️
docling_core/transforms/serializer/doctags.py	60.00%	4 Missing ⚠️
...core/transforms/visualizer/key_value_visualizer.py	33.33%	4 Missing ⚠️
docling_core/types/doc/base.py	77.77%	4 Missing ⚠️
... and 13 more

📢 Thoughts on this report? Let us know!

ceberam · 2026-01-12T15:54:38Z

@schwarbf sorry for the late reply. Would you mind rebasing to the latest main?

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

…aises fewer issues Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

…ff (i.e. no separate [tool.flake8] section Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

…= 120 equals now what was set for the .flake8 settings Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

… one linting check would fail Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

ceberam · 2026-01-13T10:28:36Z

@schwarbf I have rebased and force-pushed your commits. I'll add a couple of them to fix some small details and apply a couple of additional style rules.

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

schwarbf · 2026-01-13T15:00:44Z

@schwarbf I have rebased and force-pushed your commits. I'll add a couple of them to fix some small details and apply a couple of additional style rules.

@ceberam That's fine thanks. I was going to do it tonight. Seems like we're ready to merge apart from the codecov check which was probably failing before as well?

ceberam · 2026-01-13T16:03:40Z

@schwarbf I have rebased and force-pushed your commits. I'll add a couple of them to fix some small details and apply a couple of additional style rules.

@ceberam That's fine thanks. I was going to do it tonight. Seems like we're ready to merge apart from the codecov check which was probably failing before as well?

All good @schwarbf , thanks for your contribution!

schwarbf changed the title ~~Replace black and isort by ruff~~ Replace black and isort by ruff Dec 10, 2025

schwarbf changed the title ~~Replace black and isort by ruff~~ chore:Replace black and isort by ruff Dec 10, 2025

schwarbf changed the title ~~chore:Replace black and isort by ruff~~ chore: Replace black and isort by ruff Dec 10, 2025

ceberam reviewed Dec 12, 2025

View reviewed changes

schwarbf force-pushed the dev/introduce-ruff-to-docling-core branch from 4c618ea to 85a1889 Compare December 12, 2025 19:18

schwarbf changed the title ~~chore: Replace black and isort by ruff~~ chore: Replace black, isort, flak8 and autoflake by ruff Dec 12, 2025

schwarbf requested a review from ceberam December 12, 2025 20:48

Florian Schwarb added 17 commits January 13, 2026 11:10

Added ruff to dev dependencies

595a26a

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Added ruff settings to pyproject.toml as in docling

18cde33

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Cleanup uf pyproject.toml

4a435d5

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Copied settings for ruff pre-commit hooks from docling

6f369f6

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Excluded test/data/** from ruff formatting / linting

735af19

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

ruff format

e37506b

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Added some ignore statements to pyproject.toml such that ruff check r…

1a748ca

…aises fewer issues Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

ruff check --fix

a35d7ca

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Ignored some more rules

9769035

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Fixed the rest of the errors that would only concern 1 - 3 files

0ebeb43

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Added another ignore related to df for DataFrame names

fb1cb1a

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Modified CONTRIBUTING.md such that black / isort are replaced by ruff

b4f8ca0

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Added UP045 to ignore list such that Optional[...] does not raise

8c553eb

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Moved .flake8 configs to pyproject.toml

3dc2048

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Moved autoflake to be used with ruff

86686ef

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Moved all .flake8 settings to pyproject.toml to be compatible with ru…

1cd3d3f

…ff (i.e. no separate [tool.flake8] section Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Removed flake8 from .pre-commit hooks

f575e2c

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Florian Schwarb added 4 commits January 13, 2026 11:21

Applied ruff format (again); formatted some files as the line-length …

0a23adb

…= 120 equals now what was set for the .flake8 settings Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Set max-complexity to 30 (as was originally) in the pyproject.toml as…

6a3aabe

… one linting check would fail Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Adding PD901 to ignore list such that pre-commit hooks run fully again

c362673

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

Replaced dtype | None syntax by Optional[dtype] in remaining places

b60b5c3

Signed-off-by: Florian Schwarb <florian.schwarb@gmail.com>

ceberam force-pushed the dev/introduce-ruff-to-docling-core branch from 7b6da2d to b60b5c3 Compare January 13, 2026 10:27

ceberam changed the title ~~chore: Replace black, isort, flak8 and autoflake by ruff~~ style: replace black, isort, flake8 and autoflake with ruff Jan 13, 2026

ceberam added 9 commits January 13, 2026 14:52

chore: fix 'test' ref in pyproject

847e5fb

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove typing List, Set, Tuple, Dict

148c03f

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove UP015 check from ignore list

0b85e82

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove UP034 check from ignore list

6f4b277

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: normalize dashes in comments and docstrings

72e6902

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove PD901 check from ignore list

d24bcaf

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove C403 check from ignore list

3fa75d0

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove C403, C413, C416 check from ignore list

2deeb03

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

style: remove E203, F811 check from ignore list

a73490d

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

ceberam force-pushed the dev/introduce-ruff-to-docling-core branch from d4b6f87 to a73490d Compare January 13, 2026 13:56

ceberam approved these changes Jan 13, 2026

View reviewed changes

ceberam requested review from PeterStaar-IBM, cau-git, dolfim-ibm and vagenas January 13, 2026 14:02

dolfim-ibm approved these changes Jan 13, 2026

View reviewed changes

cau-git approved these changes Jan 13, 2026

View reviewed changes

ceberam merged commit c73904e into docling-project:main Jan 13, 2026
11 of 12 checks passed

This was referenced Jan 21, 2026

fix: markdown export under -O #462

Closed

UnboundLocalError in markdown serializer when running with PYTHONOPTIMIZE=1 #460

Closed

ceberam mentioned this pull request Feb 2, 2026

Migrate formatter and linter to ruff #453

Closed

Conversation

schwarbf commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dosubot bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergify bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Protections

🟢 Enforce conventional commit

🟢 Require two reviewer for test updates

Uh oh!

ceberam Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

schwarbf Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

ceberam Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

schwarbf Dec 16, 2025

Choose a reason for hiding this comment

Uh oh!

schwarbf commented Dec 12, 2025

Uh oh!

codecov bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ceberam commented Jan 12, 2026

Uh oh!

ceberam commented Jan 13, 2026

Uh oh!

schwarbf commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ceberam commented Jan 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

schwarbf commented Dec 10, 2025 •

edited

Loading

github-actions bot commented Dec 10, 2025 •

edited

Loading

dosubot bot commented Dec 10, 2025 •

edited

Loading

mergify bot commented Dec 10, 2025 •

edited

Loading

codecov bot commented Jan 12, 2026 •

edited

Loading

schwarbf commented Jan 13, 2026 •

edited

Loading